Publishing an Algorithm
An algorithm is a script that can be used to run on top of a compatible dataset (compute type), to produce a distributable output file without having to expose the original data.
To publish an algorithm:
- Log in to the marketplace.
- From the left navigation bar, go to Create > Algorithm.
Step 1: Connect Your Asset
- Select the Access Type of your Algorithm between a public and private algorithm.
- Public Algorithm: By making an Algorithm public, Data Consumers can download a copy of Algorithm and/or also use it paired with a Dataset. Compute data owners can choose to trust this Algorithm regardless of the edge node that is used to connect to the Dataset.
- Private Algorithm: By making an Algorithm private, Data Consumers can only make use of this Algorithm if paired with a Dataset. Compute data owners can only trust this algorithm if the Algorithm is connected to the same edge node as the Dataset.
- Select the Algorithm Type for your Algorithm: 'Basic', 'Federated', or 'Aggregate'
- Basic: used for a single dataset computation.
- Federated: used to run on multiple datasets simultaneously, producing multiple outputs from computation.
- Aggregate: used to combine the multiple outputs into a single output.
- Select the Edge Node that will connect to the data source.
- Paste the Source URL of the dataset.
- Optional: Add key-value pairs of HTTP headers in your API by clicking 'Add HTTP Headers'.
Step 2: Basic Information
- If your algorithm does NOT meant to process real data, select 'Experimental'. Otherwise, select 'Production'.
- Name your algorithm by providing a concise Algorithm Title that will capture the initial attention of potential data consumers.
- Categorize your algorithm according to the closest industry Category.
- Provide an Overview of your algorithm as a summary.
- Provide Additional Details, or any additional information that you think will be helpful to potential data consumers. E.g., data attributes, purpose, etc.
- Select the appropriate Runtime Environment of your algorithm. For Custom Docker Image, indicate the image registry path, digest, entrypoint and reference URL.
- Select the Validity Period - how long your algorithm should be available to the data consumer after purchase.
Step 3: Further Details
- Indicate the Asset Permissions - whether to initially 'Allow All Users' or 'Deny All Users' from consuming your data asset.
- Optional: Tag your assets with related keywords to make it searchable to a wider audience.
- Optional: Upload or link a Sample File that can be downloaded by data consumers before purchasing your actual data.
- Optional: Upload a Sample Image file or screenshot of your asset.
- Optional: Link your End User License Agreement to specify any terms and conditions for the use of your data asset.